From: Jonathan Dieter Date: Sat, 11 May 2019 21:23:45 +0000 (+0100) Subject: Update README.md with links to some documentation X-Git-Tag: archive/raspbian/1.1.9+ds1-1+rpi1~1^2~41 X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=f1a3824aa602213d7764558527efd6e650235029;p=zchunk.git Update README.md with links to some documentation Signed-off-by: Jonathan Dieter --- diff --git a/README.md b/README.md index ed6a95f..178288f 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,8 @@ of the file, and also makes zchunk files efficient over rsync. zchunk files are protected with strong checksums to verify that the file you downloaded is, in fact, the file you wanted. -**zchunk-0.9.0 has been released with the proposed final ABI. Once zchunk-1.0 -has been released, the ABI will be marked as stable, and the only allowed -API/ABI and file format changes will be additions** - +**As of zchunk-1.0, the ABI and API have been marked stable, and the only changes +allowed are backwards-compatible additions** ## Installation To build and install zchunk, first install meson and run @@ -46,5 +44,7 @@ To read a zchunk header, run: zck_read_header ``` -## C API -\#TODO +## Documentation +- [Format definition](zchunk_format.txt) +- [Initial announcement](https://www.jdieter.net/posts/2018/04/30/introducing-zchunk) +- [How zchunk works (with pretty pictures)](https://www.jdieter.net/posts/2018/05/31/what-is-zchunk)